home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / logbatch / xnews3.exe / MANUAL.DOC < prev    next >
Text File  |  1994-03-04  |  13KB  |  353 lines
  1. x-NEWS3 Network News Login System
  2. Extensions Software Corporation
  3.  
  4.  
  5. Operations Guide Table of Contents
  6. ----------------------------------
  7. Shareware Note..................................... 2
  8. Disclaimer Agreement............................... 2
  9. Copyright Notice................................... 2
  10. Trademarks Notice.................................. 2
  11. Introduction....................................... 3
  12. Requirements....................................... 3
  13. Installation....................................... 4
  14. Configuration File..................................5
  15. News/Announcement Files............................ 7
  16. x-NEWS3 Display.................................... 7
  17. Technical Support.................................. 8
  18.  
  19.  
  20. Ombudsman Statement
  21. -------------------
  22. Extensions Software Corporation is a member of the Association of
  23. Shareware Professionals (ASP). ASP wants to make sure that the
  24. shareware principle works for you. If you are unable to resolve a
  25. shareware-related problem with an ASP member by contacting the member
  26. directly, ASP may be able to help. The ASP Ombudsman can help you
  27. resolve a dispute or problem with an ASP member, but does not provide
  28. technical support for members' products. Please write to:
  29.  
  30.           _______
  31.      ____|__     |               (r)
  32.   --|       |    |-------------------     ASP Ombudsman
  33.     |   ____|__  |  Association of        545 Grover Road
  34.     |  |       |_|  Shareware             Muskegon, MI 49442-9427 USA
  35.     |__|   o   |    Professionals         616-788-2765 FAX
  36.   -----|   |   |---------------------     70007,3536 CompuServe
  37.        |___|___|
  38.  
  39.  
  40. x-NEWS3 Operations Guide - Page 2
  41.  
  42.  
  43. Shareware Note
  44. --------------
  45. This program is being distributed as shareware or try-before-you-buy
  46. software. You are granted a temporary license to use and evaluate the
  47. program, but continued use after the initial testing period requires
  48. registration with Extensions Software Corporation.
  49.  
  50. This unregistered software version contains the following limitations
  51. and/or characteristics:
  52.  
  53.   - Registration reminder screens will be displayed.
  54.   - The maximum number of users allowed is 5.
  55.  
  56. Registration of this software provides users with the following:
  57.  
  58.   - Serialized disks (dual media) of the latest software without
  59.     registration reminder screens and without user limitations
  60.   - Desk-top-published, laser-printed operations guide
  61.   - Technical support by mail/phone/FAX/BBS/CompuServe
  62.   - Notification of major software updates/upgrades
  63.   - New product announcements
  64.  
  65.  
  66. Disclaimer Agreement
  67. --------------------
  68. Users of this program must accept the following disclaimer of
  69. warranty:
  70.  
  71.   THIS SOFTWARE AND OPERATIONS GUIDE ARE SUPPLIED AS IS. EXTENSIONS
  72.   SOFTWARE CORPORATION DISCLAIMS ALL WARRANTIES, EXPRESSED OR IMPLIED,
  73.   INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY AND
  74.   FITNESS FOR ANY PURPOSE. EXTENSIONS SOFTWARE CORPORATION ASSUMES NO
  75.   LIABILITY FOR DAMAGES, EITHER DIRECT OR CONSEQUENTIAL, WHICH MAY
  76.   RESULT FROM THE USE OF THIS SOFTWARE.
  77.  
  78.  
  79. Copyright Notice
  80. ----------------
  81. The x-NEWS3 software and x-NEWS3 operations guide are copyrighted (c)
  82. 1993-94 by Extensions Software Corporation. All Rights Reserved.
  83.  
  84.  
  85. Trademarks Notice
  86. -----------------
  87. Banyan, VINES, and StreetTalk are trademarks of Banyan Systems, Inc.
  88. Novell and NetWare are trademarks of Novell, Inc.
  89. IBM and PC DOS are trademarks of International Business Machines Corp.
  90. MS DOS is a trademark of MicroSoft Corp.
  91.  
  92. All other product names and/or trademarks used within the software or
  93. operations guide are the property of their respective companies.
  94.  
  95. x-NEWS3 Operations Guide - Page 3
  96.  
  97.  
  98. Introduction
  99. ------------
  100. x-NEWS3 is a network software product from Extensions Software
  101. Corporation that provides a low-cost, easy-to-maintain method of
  102. displaying company news, information, notices, announcements, and
  103. bulletins to network users.
  104.  
  105. x-NEWS3 features include the following:
  106.  
  107.   - Automatic tracking of news/announcements read per user
  108.  
  109.   - Configurable display intervals (every network login or only once
  110.     on specified days of the week) per news/announcement
  111.  
  112.   - Use of standard ASCII text files for notices and announcements
  113.  
  114.   - Use of imbedded macro commands to add color to news and
  115.     announcements
  116.  
  117.   - Use of imbedded control macro commands for displaying the logged
  118.     in user name and for centering text
  119.  
  120.   - Up to 25 news/announcement files with up to 20 lines of text each
  121.  
  122.   - Configurable system name and display timeout
  123.  
  124.   - Network-aware of both Banyan VINES(R) and Novell NetWare(R)
  125.  
  126.  
  127. Requirements
  128. ------------
  129. For Standalone PC Use:
  130.  
  131.   - IBM or 100% compatible computer with 256K available memory
  132.   - Floppy disk drive (5.25" 360K or 1.2M, or 3.50" 720K or 1.44M)
  133.   - Fixed disk drive
  134.   - Monochrome or color (CGA/EGA/VGA) display
  135.   - MS or PC DOS 3.1 or higher
  136.  
  137. For Network Use:
  138.  
  139.   Banyan VINES(R) or Novell NetWare(R) network operating system and
  140.   workstations that meet the standalone PC requirements listed above.
  141.  
  142. x-NEWS3 Operations Guide - Page 4
  143.  
  144.  
  145. Installation
  146. ------------
  147. The x-NEWS3 diskette (or self-archived/zipped file) contains the
  148. single X-NEWS3.EXE executable program.
  149.  
  150. The x-NEWS3.EXE file can be copied to any network or standalone PC
  151. subdirectory and then executed.
  152.  
  153. The example explained below, however, offers maximum security benefits
  154. for installation on a computer network. Note that you must have ADMIN
  155. or SUPERVISOR rights to all specified subdirectories in order to
  156. install and initially run x-NEWS3.
  157.  
  158. To install x-NEWS3:
  159.  
  160. A) Create three subdirectories on your standalone PC or your network
  161.    file server per the following example:
  162.  
  163.    1) \NEWS
  164.    2) \NEWS\DATA
  165.    3) \NEWS\TEXT
  166.  
  167.    ...where:
  168.  
  169.    Subdirectory  Contents                            User Access
  170.    ------------  ----------------------------------  -----------------
  171.    \NEWS         The X-NEWS3.EXE file                Read-Only
  172.    \NEWS\DATA    The database and index files        Read/Write/Modify
  173.    \NEWS\TEXT    The news/announcement text files    Read-Only
  174.  
  175. B) Copy the X-NEWS3.EXE file from the floppy diskette to the \NEWS
  176.    subdirectory.
  177.  
  178. C) At the DOS prompt, type X-NEWS3 followed by the data
  179.    volume/subdirectory name plus the news volume/subdirectory name.
  180.  
  181.    For example, assuming that drive volume N: is the network drive,
  182.    the syntax to start x-NEWS3 would be as follows:
  183.  
  184.    N:\NEWS\X-NEWS3 N:\NEWS\DATA N:\NEWS\TEXT
  185.  
  186.    Typically, this DOS command line syntax would be included in a
  187.    batch file which is subsequently called by a Banyan VINES POSTLOGIN
  188.    command or by the Novell NetWare SYSTEM LOGIN script.
  189.  
  190.    Note that if x-NEWS3 has been installed on a Banyan VINES network,
  191.    the user login name is obtained directly from StreetTalk(tm). If
  192.    x-NEWS3 has been installed on a Novell NetWare network, the user
  193.    login name and unique NIC address are obtained directly from the
  194.    network operating system. Otherwise, the user name for x-NEWS3
  195.    defaults to LOCAL USER.
  196.  
  197. D) x-NEWS3 will self-install when run for the first time by creating
  198.    the necessary database/index files, the X-NEWS3.CFG configuration
  199.    file, and two sample news text files named NEWS_01 and NEWS_02.
  200.  
  201. x-NEWS3 Operations Guide - Page 5
  202.  
  203.  
  204. Configuration File
  205. ------------------
  206. The X-NEWS3.CFG configuration file allows easy maintenance of certain
  207. x-NEWS3 operating parameters as well as announcement/news file names,
  208. descriptions, and display intervals.
  209.  
  210. When first installed, x-NEWS3 will automatically create the following
  211. X-NEWS3.CFG configuration file:
  212.  
  213.   * x-NEWS3 Configuration File *
  214.   *----------------------------*
  215.   SYSNAME = XYZ Corporation IMS
  216.   DISPLAY = 45
  217.   FILE_01 = NEWS_01
  218.   DESC_01 = x-NEWS3 Welcome!
  219.   DAYS_01 = SUN MON TUE WED THU FRI SAT
  220.   FILE_02 = NEWS_02
  221.   DESC_02 = x-NEWS3 Order Info
  222.   DAYS_02 = SUN MON TUE WED THU FRI SAT
  223.   FILE_03 = NEWS_03
  224.   DESC_03 = Required Virus Scans
  225.   DAYS_03 =
  226.  
  227.   ...where:
  228.  
  229.   Parameter  Description
  230.   ---------  -------------------------------------------------------
  231.   SYSNAME    The name assigned to your x-NEWS3 system or location
  232.   DISPLAY    The screen display time per news/announcement (seconds)
  233.   FILE_nn    The file name of news/announcement number nn
  234.   DESC_nn    The description of news/announcement number nn
  235.   DAYS_nn    The display interval for news/announcement number nn
  236.  
  237. The SYSNAME parameter must be 30 characters or less in length.
  238.  
  239. The DISPLAY parameter is the maximum number of seconds each
  240. news/announcement is displayed to the user, although the user may
  241. advance to the next news/announcement with a single keypress.
  242.  
  243. A maximum of twenty (25) news/announcement files, descriptions, and
  244. intervals may be included in the X-NEWS3.CFG configuration file. These
  245. must be labeled FILE_01/DESC_01/DAYS_01 thru FILE_25/DESC_25/DAYS_25
  246. as indicated in the above example.
  247.  
  248. X-NEWS3.CFG configuration file names (FILE_xx) must be 12 characters
  249. or less in length. Descriptions (DESC_xx) must be 30 characters or
  250. less in length. Intervals (DAYS_xx) must use the following days of
  251. the week syntax:
  252.  
  253.   SUN = Sunday
  254.   MON = Monday
  255.   TUE = Tuesday
  256.   WED = Wednesday
  257.   THU = Thursday
  258.   FRI = Friday
  259.   SAT = Saturday
  260.  
  261. x-NEWS3 Operations Guide - Page 6
  262.  
  263.  
  264. News/announcement interval examples are as follows:
  265.  
  266.   DAYS_xx = SUN MON TUE WED THU FRI SAT --> will be displayed the
  267.                                             first time a user logs
  268.                                             into the network on each
  269.                                             day of the week
  270.  
  271.   DAYS_xx = MON WED FRI                 --> will be displayed the
  272.                                             first time a user logs
  273.                                             into the network on each
  274.                                             Monday, Wednesday, and
  275.                                             Friday
  276.  
  277.   DAYS_xx =                             --> will be displayed EVERY
  278.                                             time a user logs into the
  279.                                             network
  280.  
  281. Note that the X-NEWS3.CFG configuration file may not contain more than
  282. 80 total lines of text, and each line of text may not exceed 70
  283. characters total length.
  284.  
  285. x-NEWS3 Operations Guide - Page 7
  286.  
  287.  
  288. News/Announcement Files
  289. -----------------------
  290. To add news or announcements, simply create them using any ASCII text
  291. editor, copy the files to your x-NEWS3 text subdirectory, and then
  292. include the file names/descriptions/intervals in the X-NEWS3.CFG
  293. configuration file.
  294.  
  295. Each news/announcement text file may have a maximum of twenty (20)
  296. lines of text. Information files that must be displayed but are longer
  297. than 20 lines of text can simply be divided into separate text files.
  298.  
  299. The default news/announcement display color is GRAY. Color macros may
  300. be imbedded into any x-NEWS3 news/announcement text file by including
  301. a proper color command macro enclosed in brackets. Allowable color
  302. command macros include the following:
  303.  
  304.   [RED] = Red
  305.   [WHT] = White
  306.   [GRY] = Gray
  307.   [MAG] = Magenta
  308.   [BLU] = Blue
  309.   [GRN] = Green
  310.   [BRN] = Brown
  311.   [YEL] = Yellow
  312.  
  313. The logged in user name may be displayed in any news/announcement file
  314. by using the [USERNAME] command macro.
  315.  
  316. A line of text in any news/announcement file may be centered by
  317. including the [CENTER] command macro at the beginning of the line of
  318. text.
  319.  
  320. Please examine the sample files NEWS_01 and NEWS_02 for additional
  321. insight as to the use of these x-NEWS3 command macros.
  322.  
  323.  
  324. x-NEWS3 Display
  325. ---------------
  326. Once a news/announcement text screen has been displayed, pressing any
  327. key causes x-NEWS3 to display the next news/announcement. x-NEWS3
  328. always displays news/announcements in numerical order (ie, FILE_01
  329. followed by FILE_02 followed by FILE_03 etc).
  330.  
  331. x-NEWS3 Operations Guide - Page 8
  332.  
  333.  
  334. Technical Support
  335. -----------------
  336. Limited technical support by mail, phone, FAX, BBS, and CompuServe is
  337. provided at no cost to UNLICENSED users during the initial software
  338. evaluation period.
  339.  
  340. Continued technical support by mail, phone, FAX, BBS, and CompuServe
  341. is provided at no cost to LICENSED users.
  342.  
  343. For technical support, please contact:
  344.  
  345. Extensions Software Corporation
  346. 224 Thompson Street #165
  347. Hendersonville, NC  28792-2805  USA
  348. 704-692-0887
  349. 704-692-8879 FAX
  350. 704-693-0339 BBS
  351. 72007,571 CompuServe
  352.  
  353.